[Protobuf Schema] Add Support for Multiple Response#20989
Merged
wing328 merged 4 commits intoOpenAPITools:masterfrom Mar 31, 2025
Merged
[Protobuf Schema] Add Support for Multiple Response#20989wing328 merged 4 commits intoOpenAPITools:masterfrom
wing328 merged 4 commits intoOpenAPITools:masterfrom
Conversation
wing328
reviewed
Mar 29, 2025
| |aggregateModelsName|Aggregated model filename. If set, all generated models will be combined into this single file.| |null| | ||
| |numberedFieldNumberList|Field numbers in order.| |false| | ||
| |startEnumsWithUnspecified|Introduces "UNSPECIFIED" as the first element of enumerations.| |false| | ||
| |supportMultipleResponses|Support multiple responses| |false| |
Member
There was a problem hiding this comment.
thanks for the enhancement. what about defaulting this option to true to make multiple responses work right out-of-the-box?
dfe1169 to
8ebeb88
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
#20472
This PR introduces a new flag for the Protobuf generator to support multiple responses.
Previously, if an operation defined multiple responses, only one response was selected. With this PR, when the flag is enabled, the generator will produce a Protobuf message that uses a oneof field to include all defined responses (e.g., 200, 400, etc.)
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)